<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Workspace (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="Workspace (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Workspace.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/project/api/Projects.html" title="interface in org.gephi.project.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/project/api/WorkspaceInformation.html" title="interface in org.gephi.project.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/project/api/Workspace.html" target="_top">Frames</a></li>
<li><a href="Workspace.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.project.api</div>
<h2 title="Interface Workspace" class="title">Interface Workspace</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>org.openide.util.Lookup.Provider</dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">Workspace</span>
extends org.openide.util.Lookup.Provider</pre>
<div class="block">Workspace interface that internally stores, through its <b>Lookup</b>, various
 information and instances.
 <p>
 Workpace is a top concept in Gephi because all models that modules
 possesses are usually divided by workspace, for instance one <code>GraphModel</code>
 per workspace. Therefore this class has a Lookup mechanism to let modules store
 their model in the workspace's lookup and query it when needed.
 <p>
 To know how you can manage loading and saving data in Gephi project files, see
 <a href="../../../../org/gephi/project/spi/WorkspacePersistenceProvider.html" title="interface in org.gephi.project.spi"><code>WorkspacePersistenceProvider</code></a>.
 <h3>How to associate new data model to the workspace</h3>
 In your new module, listen to <a href="../../../../org/gephi/project/api/WorkspaceListener.html" title="interface in org.gephi.project.api"><code>WorkspaceListener</code></a> and call <code>add()</code>
 method when initialize:
 <pre>public void initialize(Workspace workspace) {
      workspace.add(new MyDataModel())
}
 </pre>
 When a workspace is selected, retrieve the workspace's data model:
 <pre>public void select(Workspace workspace) {
      MyDataModel model = workspace.getLookup().lookup(MyDataModel.class);
}
 </pre></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/project/api/Workspace.html#add(java.lang.Object)">add</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;instance)</code>
<div class="block">Adds an instance to this workspaces lookup.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>org.openide.util.Lookup</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/project/api/Workspace.html#getLookup()">getLookup</a></strong>()</code>
<div class="block">Get any instance in the current lookup.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/project/api/Workspace.html#remove(java.lang.Object)">remove</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;instance)</code>
<div class="block">Removes an instance from this workspaces lookup.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="add(java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre>void&nbsp;add(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;instance)</pre>
<div class="block">Adds an instance to this workspaces lookup.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the instance that is to be pushed to the lookup</dd></dl>
</li>
</ul>
<a name="remove(java.lang.Object)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre>void&nbsp;remove(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;instance)</pre>
<div class="block">Removes an instance from this workspaces lookup.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>instance</code> - the instance that is to be removed from the lookup</dd></dl>
</li>
</ul>
<a name="getLookup()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getLookup</h4>
<pre>org.openide.util.Lookup&nbsp;getLookup()</pre>
<div class="block">Get any instance in the current lookup. All important API in Gephi are
 storing models in this lookup.
 <p>
 May contains:
 <ol><li><code>GraphModel</code></li>
 <li><code>AttributeModel</code></li>
 <li><code>LayoutModel</code></li>
 <li><code>StatisticsModel</code></li>
 <li><code>FiltersModel</code></li>
 <li><code>PreviewModel</code></li>
 <li><code>VizModel</code></li>
 <li>...</li>
 </ol></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code>getLookup</code>&nbsp;in interface&nbsp;<code>org.openide.util.Lookup.Provider</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the workspace's lookup</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Workspace.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/project/api/Projects.html" title="interface in org.gephi.project.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/project/api/WorkspaceInformation.html" title="interface in org.gephi.project.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/project/api/Workspace.html" target="_top">Frames</a></li>
<li><a href="Workspace.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
